/*
 * %W% %E%
 *
 * Copyright  1990-2006 Sun Microsystems, Inc. All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation. 
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt). 
 * 
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA 
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions. 
 */

package com.sun.jump.os;

import java.io.IOException;

import com.sun.jump.message.JUMPMessagable;
import com.sun.jump.message.JUMPTimedOutException;
import com.sun.jump.message.JUMPUnblockedException;

/**
 * <code>JUMPMessageQueue</code> abstracts the communication channels between
 * the system executive and the isolates. This is a low-level porting
 * interface and is used by the implementation and not directly by modules.
 */
public abstract class JUMPMessageQueueInterface {
    
    /**
     * Creates a new instance of JUMPMessageQueue
     */
    protected JUMPMessageQueueInterface() {
    }
    
    /**
     * Get offset of non-OS data in message buffer 
     */
    public abstract int getDataOffset();

    /** 
     * Must have exception interface
     *
     * @throws JUMPTimedOutException
     * @throws JUMPUnblockedException
     * @throws IOException
     */
    public abstract byte[] receiveMessage(String type, long timeout)
	throws JUMPTimedOutException, IOException;

}
